How to use the wiki

---

Simple markdown

To see al the markdown syntax you can visit the markdown cheatsheet

Homepage

The homepage is default the “homepage.md” file, this can’t be changed. If this file doesn’t exist create it in de wiki folder.

Static images

If you have images that you don’t want to be available on the internet, you can put them inside the folder “static/images/” for example “testfile.png”, now you can link to “/static/images/testfile.png”

Latex

It’s possible to use latex syntax inside your markdown because the markdown is first converted to latex and after that to html. This means you have a lot more flexibility.

Change image size

![](https://i.ibb.co/Dzp0SfC/download.jpg){width="50%"}

Image references

![\label{test}](https://i.ibb.co/Dzp0SfC/download.jpg){width="50%"}

Inside picture \ref{landscape picture} you can see a nice [mountain](Mountains).

Clickable reference in picture .

Math

\begin{align}
y(x) &= \int_0^\infty x^{2n} e^{-a x^2}\,dx\\
&= \frac{2n-1}{2a} \int_0^\infty x^{2(n-1)} e^{-a x^2}\,dx\\
&= \frac{(2n-1)!!}{2^{n+1}} \sqrt{\frac{\pi}{a^{2n+1}}}\\
&= \frac{(2n)!}{n! 2^{2n+1}} \sqrt{\frac{\pi}{a^{2n+1}}}
\end{align}

You can also use $inline$ math to show $a=2$ and $b=8$

You can also use inline math to show a = 2 and b = 8

And many other latex functions.

Converting the files

Open the wiki folder of your instance.

|- static
|- templates
|- wiki ← This folder
|- wiki.py

In this folder all the markdownfiles are listed. Editing the files will be visible in the web-version.

|- homepage.md
|- How to use the wiki.md
|- Markdown cheatsheet.md

The advantage is that u can use the commandline to process some data. For example using pandoc:

$ pandoc -f markdown -t latex [homepage](homepage).md How\ to\ use\ the\ wiki.md -o file.pdf --pdf-engine=xelatex

This creates a nice pdf version of your article. Its possible you have to create a yml header on top of your document to set the margins etc better

---
title: titlepage
author: your name
date: 05-11-2020
geometry: margin=2.5cm
header-includes: |
        \usepackage{caption}
        \usepackage{subcaption}
lof: true
---

For more information you have to read the pandoc documentation.

Using the version control system

---

Last modified: Wed Oct 16 22:06:42 2024